CancelTransaction

Definition:

CancelTransaction(tag)

 

Description:

Cancel an asynchronous data synchronisation transaction initiated by a call to the Synchronise Method.

 

Platforms:

All

 

Parameters:

tag - required

This parameter is not currently used. Enter an empty string, "", to cancel the currently active asynchronous data transaction.

 

Returns:

nothing

 

Notes:

  • This Method will only have an effect if an asynchronous synchronisation transaction is in progress, previously initiated by a call to the Synchronise Method.

  • Cancelling a data transfer should result in the local database tables being unaffected. All modified records should remain marked as modified. You can check whether a local database table has completed uploading by checking for the presence of modified records using GetModifiedRecords and checking the return value. If the return value is zero then all records were uploaded successfully. If the return value is greater than zero then the local records haven't been uploaded. The remote data source may have been updated with records uploaded from the device but performing the upload again won't affect records already updated in the remote data source and will clear the modified record flag in all local records, if successful.


See also:

Synchronise

GetTransactionProgress

GetTransactionState

GetNumSyncErrors

GetSyncErrorDescription

GetSyncErrorDataSource

GetSyncErrorRecordIndex

GetModifiedRecords